home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimppixmap.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  4.5 KB  |  138 lines
  1. <refentry id="GimpPixmap" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>GimpPixmap</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>GimpPixmap</refname><refpurpose>Widget which creates a <link linkend="GtkPixmap">GtkPixmap</link> from XPM data.</refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. struct      <link linkend="GimpPixmap-struct">GimpPixmap</link>;
  18. #define     <link linkend="GIMP-PIXMAP-CAPS">GIMP_PIXMAP</link>                     (obj)
  19. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-pixmap-new">gimp_pixmap_new</link>                 (<link linkend="gchar">gchar</link> **xpm_data);
  20. void        <link linkend="gimp-pixmap-set">gimp_pixmap_set</link>                 (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
  21.                                              <link linkend="gchar">gchar</link> **xpm_data);
  22.  
  23. </synopsis>
  24. </refsynopsisdiv>
  25.  
  26. <refsect1>
  27. <title>Object Hierarchy</title>
  28. <synopsis>
  29.  
  30.   <link linkend="GtkObject">GtkObject</link>
  31.    +----<link linkend="GtkWidget">GtkWidget</link>
  32.          +----<link linkend="GtkMisc">GtkMisc</link>
  33.                +----<link linkend="GtkPixmap">GtkPixmap</link>
  34.                      +----GimpPixmap
  35. </synopsis>
  36.  
  37. </refsect1>
  38.  
  39.  
  40.  
  41.  
  42. <refsect1>
  43. <title>Description</title>
  44. <para>
  45. Widget which creates a <link linkend="GtkPixmap">GtkPixmap</link> from XPM data.
  46. </para>
  47. <para>
  48. Use this widget instead of <link linkend="GtkPixmap">GtkPixmap</link> if you don't want to worry about
  49. the parent container's "realized" state.
  50. </para>
  51. <para>
  52. Note that the drawback of the easy interface is that the actual <link linkend="GdkPixmap">GdkPixmap</link>
  53. and it's mask have to be constructed every time you call <link linkend="gimp-pixmap-new">gimp_pixmap_new</link>()
  54. and cannot be cached in memory without doing bad hacks.
  55. </para>
  56. </refsect1>
  57.  
  58. <refsect1>
  59. <title>Details</title>
  60. <refsect2>
  61. <title><anchor id="GimpPixmap-struct">struct GimpPixmap</title>
  62. <programlisting>struct GimpPixmap;</programlisting>
  63. <para>
  64.  
  65. </para></refsect2>
  66. <refsect2>
  67. <title><anchor id="GIMP-PIXMAP-CAPS">GIMP_PIXMAP()</title>
  68. <programlisting>#define GIMP_PIXMAP(obj)            (GTK_CHECK_CAST ((obj), GIMP_TYPE_PIXMAP, GimpPixmap))
  69. </programlisting>
  70. <para>
  71. Checks if the passed pointer is a pointer to a <link linkend="GimpPixmap">GimpPixmap</link> and
  72. performs the cast if valid.
  73. </para><informaltable pgwide=1 frame="none" role="params">
  74. <tgroup cols="2">
  75. <colspec colwidth="2*">
  76. <colspec colwidth="8*">
  77. <tbody>
  78. <row><entry align="right"><parameter>obj</parameter> :</entry>
  79. <entry>The pointer to cast.
  80.  
  81.  
  82. </entry></row>
  83. </tbody></tgroup></informaltable></refsect2>
  84. <refsect2>
  85. <title><anchor id="gimp-pixmap-new">gimp_pixmap_new ()</title>
  86. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_pixmap_new                 (<link linkend="gchar">gchar</link> **xpm_data);</programlisting>
  87. <para>
  88. Creates a new <link linkend="GimpPixmap">GimpPixmap</link> widget.</para>
  89. <para>
  90.  
  91. </para><informaltable pgwide=1 frame="none" role="params">
  92. <tgroup cols="2">
  93. <colspec colwidth="2*">
  94. <colspec colwidth="8*">
  95. <tbody>
  96. <row><entry align="right"><parameter>xpm_data</parameter> :</entry>
  97. <entry> A pointer to a XPM data structure as found in XPM files.
  98. </entry></row>
  99. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GimpPixmap">GimpPixmap</link> widget.
  100. </entry></row>
  101. </tbody></tgroup></informaltable></refsect2>
  102. <refsect2>
  103. <title><anchor id="gimp-pixmap-set">gimp_pixmap_set ()</title>
  104. <programlisting>void        gimp_pixmap_set                 (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
  105.                                              <link linkend="gchar">gchar</link> **xpm_data);</programlisting>
  106. <para>
  107. Sets a new image for an existing <link linkend="GimpPixmap">GimpPixmap</link> widget.</para>
  108. <para>
  109.  
  110. </para><informaltable pgwide=1 frame="none" role="params">
  111. <tgroup cols="2">
  112. <colspec colwidth="2*">
  113. <colspec colwidth="8*">
  114. <tbody>
  115. <row><entry align="right"><parameter>pixmap</parameter> :</entry>
  116. <entry> The pixmap widget you want to set the new xpm_data for.
  117. </entry></row>
  118. <row><entry align="right"><parameter>xpm_data</parameter> :</entry>
  119. <entry> A pointer to a XPM data structure as found in XPM files.
  120. </entry></row>
  121. </tbody></tgroup></informaltable></refsect2>
  122.  
  123. </refsect1>
  124.  
  125.  
  126.  
  127. <refsect1>
  128. <title>See Also</title>
  129. <para>
  130. <link linkend="gimp-pixmap-button-new">gimp_pixmap_button_new</link>()
  131. </para>
  132. <para>
  133. <link linkend="GtkPixmap">GtkPixmap</link>
  134. </para>
  135. </refsect1>
  136.  
  137. </refentry>
  138.